home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxMatrl.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  12.9 KB  |  383 lines
  1. //******************************************************************************
  2. //    File: tsxMatrl.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Definition of tsxMATERIAL
  5. //******************************************************************************
  6.  
  7. #ifndef TSXMATRL_H
  8. #define TSXMATRL_H
  9.  
  10.  
  11. #include "tsxTypes.h"
  12.  
  13.  
  14. //------------------------------------------------------------------------------
  15. //------------------------------------------------------------------------------
  16.  
  17. // tsxMATERIAL is used to set the material for obects and faces.
  18. // Use the following structures and functions to access, update and create
  19. // materials.  Functions for painting with materials are in "tsxPolyh.h".
  20.  
  21. //------------------------------------------------------------------------------
  22. //    Related Types and Values
  23. //------------------------------------------------------------------------------
  24.  
  25. // Solid texture direction values (used in the grain fields).
  26. #define tsxSOLID_DIR_X  0
  27. #define tsxSOLID_DIR_Y  1
  28. #define tsxSOLID_DIR_Z  2
  29.  
  30. // Simulates a granite like texture with upto 4 colors.
  31. struct CtsxGraniteProps
  32. {
  33.     CtsxColor color1;     //The different stone colors.
  34.     CtsxColor color2;
  35.     CtsxColor color3;
  36.     CtsxColor color4;
  37.     float amount1;    //Relative amount of color1 [0.0 - 1.0] (0=none)
  38.     float amount2;    //Relative amount of color2 [0.0 - 1.0]
  39.     float amount3;    //Relative amount of color3 [0.0 - 1.0]
  40.     float amount4;    //Relative amount of color4 [0.0 - 1.0]
  41.     float sharpness;    //[0.0 (max blurring to one color) - 1.0 (no blur)]
  42.     CtsxVector3f scale;    //Scaling along solid texture directions. Non-negative.
  43.             // Larger values result in finer texture. 
  44.     unsigned short seed; //Random seed for generating pattern [0 - 64k]
  45. };
  46.  
  47. // Simulates texture of swirling veins produced by turbulent forces
  48. // applied before marble solidifies.
  49. struct CtsxMarbleProps
  50. {
  51.     CtsxColor stonecol;    //Base stone color
  52.     CtsxColor veincol;    //Color of veins
  53.     short turbulence;    //Higher numbers result in larger, bumpier veins.
  54.             // 0 produces straight veins. Typically [0 - 20].
  55.     float sharpness;    //Blending between vein and stone colors at vein edges.
  56.             // Higher values increase sharpness. [0.0 - 1.0]
  57.     short grain;    //Vein direction (tsxSOLID_DIR_*).
  58.     CtsxVector3f scale; //Scaling along solid texture directions. Non-negative.
  59.             // Larger values result in more veins.
  60.     unsigned short seed; //Random seed for generating pattern [0 - 64k]
  61. };
  62.  
  63. // This produces concentric light (Spring) and dark (Summer) colored rings,
  64. // around an axis.
  65. struct CtsxWoodProps
  66. {
  67.     CtsxColor lightcol; //The light or spring color
  68.     CtsxColor darkcol;  //The dark or summer color
  69.     float ldratio;    //Light/Dark ratio.
  70.             // [0.0 (almost all dark) - 1.0 (almost all light)]
  71.     float rdensity;    //Number of rings per unit distance.
  72.     float rwidthvar;    //Variation in ring width [0.0 (uniform) - 1.0]
  73.     float rshapevar;    //Variation in ring shape [0.0 (perfect circle) - 1.0]
  74.     CtsxVector3f center; //Location of rings center.
  75.     short grain;    //Ring axis direction (tsxSOLID_DIR_*).
  76.     CtsxVector3f scale;    //Scaling along solid texture directions. Non-negative.
  77.     unsigned short seed; //Random seed for generating pattern [0 - 64k]
  78. };
  79.  
  80. // Values for CtsxProcTexture::txtrtype
  81. #define tsxTEXTURE_NONE       0
  82. #define tsxTEXTURE_GRANITE 1
  83. #define tsxTEXTURE_MARBLE  2
  84. #define tsxTEXTURE_WOOD    3
  85. // returned by `tsxMaterialGetTextureType' if texture is not procedural.
  86. // Not a valid value for field txtrtype.
  87. #define tsxTEXTURE_IMAGE   4
  88.  
  89. // Structure for specifying one of the procedural textures in tsxMATERIAL
  90. struct CtsxProcTexture
  91. {
  92.     short txtrtype; //one of tsxTEXTURE_*
  93.     union
  94.     {
  95.     CtsxGraniteProps gprops;
  96.     CtsxMarbleProps  mprops;
  97.     CtsxWoodProps    wprops;
  98.     };
  99. };
  100.  
  101. // Reflection shading types (mutually exclusive)
  102. #define tsxSHADER_FLAT    0x01
  103. #define tsxSHADER_PHONG    0x02
  104. #define tsxSHADER_METAL    0x04
  105. // Surface smoothness (mutually exclusive)
  106. #define tsxFACET_FACETED 0x01
  107. #define tsxFACET_AUTO     0x02
  108. #define tsxFACET_SMOOTH     0x04
  109.  
  110. // Surface properties ......................................
  111. struct CtsxSurfaceProps
  112. {
  113.     float ka;    //ambient coefficent [0.0 -(0.01)- 1.0]
  114.     float ks;    //specular coefficent [0.0 -(0.01)- 1.0]
  115.     float exp;    //exponent of specularity (roughness) [0.0 -(0.01)- 1.0]
  116. };
  117.  
  118. // Texture Map properties ..................................
  119.  
  120. #define tsxTXTR_OVERLAY    0x0001
  121. #define tsxTXTR_ON    0x0002  //otherwise OFF
  122. #define tsxTXTR_MOVIE    0x0004
  123. #define tsxTXTR_MARBLE  0x0400
  124. #define tsxTXTR_WOOD    0x0800
  125. #define tsxTXTR_GRANITE 0x1000
  126. // Only one of MARBLE, WOOD or GRANITE may be set.
  127.  
  128. struct CtsxTextureProps
  129. {
  130.     float offsetu;      //texture U offset [-1.0 -(.001)- 1.0]
  131.     float offsetv;      //texture V offset [-1.0 -(.001)- 1.0]
  132.     float repeatsu;        //texture repeats in U [0.01 -(.1)- 100.0]
  133.     float repeatsv;        //texture repeats in V [0.01 -(.1)- 100.0]
  134.     unsigned short flags; //see above
  135. };
  136.  
  137. // Bump Map properties .....................................
  138.  
  139. #define tsxBUMP_ON    0x0002  //otherwise OFF
  140. #define tsxBUMP_MOVIE    0x0004
  141.  
  142. struct CtsxBumpProps
  143. {
  144.     float offsetu;    //bump U offset [-1.0 -(.001)- 1.0]
  145.     float offsetv;    //bump V offset [-1.0 -(.001)- 1.0]
  146.     float repeatsu;    //bump repeats in U [0.01 -(.1)- 100.0]
  147.     float repeatsv;    //bump repeats in V [0.01 -(.1)- 100.0]
  148.     float amplitude;    //bump amplitude [-10.0 - 10.0]
  149.     unsigned short flags;    //see above
  150. };
  151.  
  152. // Environment Map properties ..............................
  153.  
  154. #define tsxENVR_CUBIC    0x0001  //cubic environment, otherwise its spherical
  155. #define tsxENVR_ON    0x0002  //otherwise OFF
  156. #define tsxENVR_MOVIE    0x0004
  157.  
  158.  
  159. #define tsxUVPROJ_PLANE        0x01
  160. #define tsxUVPROJ_PLANE_SQUARE    0x02
  161. #define tsxUVPROJ_CYLINDER    0x04
  162. #define tsxUVPROJ_SPHERE    0x08
  163.  
  164.  
  165. //------------------------------------------------------------------------------
  166. //    Managers 
  167. //------------------------------------------------------------------------------
  168.  
  169. // Create a new material object with default properties:
  170. //   - reflection shading = tsxSHADER_FLAT
  171. //   - Surface smoothness = tsxFACET_FACETED
  172. //   - alpha-chanel = 1
  173. //   - index of refraction = 1
  174. //   - Texture U repeats = 1
  175. //   - Texture V repeats = 1
  176. //   - Bump U repeats = 1
  177. //   - Bump V repeats = 1
  178. //   - Bump amplitude = 1
  179. //   - Zero (0) in the rest of the fields
  180. // Ptr to new object assigned to ppMatrl on success.
  181. TSXAPIFN tsxERR tsxMaterialCreate( tsxMATERIAL** ppMatrl );
  182.  
  183. // Create a new material object, with same properties as pOldMatrl.
  184. // Ptr to new object assigned to ppNewMatrl on success.
  185. TSXAPIFN tsxERR tsxMaterialCreateCopy(
  186.     tsxMATERIAL** ppNewMatrl,
  187.     tsxMATERIAL* pOldMatrl
  188.     );
  189.  
  190. // Create a new material object, with same properties as the Active Material.
  191. // Ptr to new object assigned to ppMatrl on success.
  192. TSXAPIFN tsxERR tsxMaterialCreateCopyActive( tsxMATERIAL** ppMatrl );
  193.  
  194. // Destroy a material object.  If assigned to faces, corresponding material
  195. // entries in matlist set to null.
  196. TSXAPIFN void tsxMaterialDestroy( tsxMATERIAL* pMatrl );
  197.  
  198.  
  199. //------------------------------------------------------------------------------
  200. //    Active Material
  201. //------------------------------------------------------------------------------
  202.  
  203. // There is an active material which in trueSpace is the material last painted,
  204. // and the default material for the next painting action.
  205.  
  206. // Set the active material to pNewActive (may be NULL).
  207. TSXAPIFN void tsxMaterialSetActive( tsxMATERIAL* pNewActive );
  208.  
  209. // Returns ptr to the Active Material (may be NULL)
  210. TSXAPIFN tsxMATERIAL* tsxMaterialGetActive();
  211.  
  212. // Copy Active Material's (if any) attributes into pMatrl.
  213. TSXAPIFN void tsxMaterialCopyActive( tsxMATERIAL* pMatrl );
  214.  
  215.  
  216. //------------------------------------------------------------------------------
  217. //    Attribute Access
  218. //------------------------------------------------------------------------------
  219.  
  220. // Testing two materials for equivalence.
  221. TSXAPIFN tsxBOOL tsxMaterialsAreEqual( tsxMATERIAL* pMatrl1,
  222.                        tsxMATERIAL* pMatrl2 );
  223.  
  224. // Get its ID (0-64K, -1 if not material)
  225. TSXAPIFN int tsxMaterialGetId( tsxMATERIAL* pMatrl );
  226.  
  227.  
  228. // Surface attributes ..........................................................
  229.  
  230. // Reflection shading (tsxSHADER_*, 0 on error)
  231. TSXAPIFN int tsxMaterialGetShadingType( tsxMATERIAL* pMatrl );
  232.  
  233. // Surface faceting (tsxFACET_*, 0 on error)
  234. TSXAPIFN int tsxMaterialGetFacetingType( tsxMATERIAL* pMatrl );
  235.  
  236. // The angle in degrees (0 - 120)
  237. TSXAPIFN int tsxMaterialGetAutofacetAngle( tsxMATERIAL* pMatrl );
  238.  
  239.  
  240. // Color
  241. TSXAPIFN void tsxMaterialGetColor( tsxMATERIAL* pMatrl, CtsxColor* pColor );
  242.  
  243. // Surface properties
  244. TSXAPIFN void tsxMaterialGetSurfaceProps( tsxMATERIAL* pMatrl,
  245.                       CtsxSurfaceProps* pSprops );
  246.  
  247. // index of refraction (1.0 - 2.0, 0 on error)
  248. TSXAPIFN float tsxMaterialGetIor( tsxMATERIAL* pMatrl );
  249.  
  250.  
  251. // Texture Map .................................................................
  252.  
  253. // Returns tsxTEXTURE_*
  254. TSXAPIFN int tsxMaterialGetTextureType( tsxMATERIAL* pMatrl );
  255.  
  256. // If not procedural texture, pPrTxt->txtrtype = tsxTEXTURE_NONE.
  257. TSXAPIFN void tsxMaterialGetProcTexture( tsxMATERIAL* pMatrl,
  258.                      CtsxProcTexture* pPrTxt );
  259.  
  260. // File used as texture map image.
  261. TSXAPIFN void tsxMaterialGetTextureFilename(
  262.     tsxMATERIAL* pMatrl,
  263.     char* szFilename,    // File name copied here, if any
  264.     int iFilenameSize    // size of szFilename buffer
  265.     );
  266.  
  267. // Texture mapping parameters
  268. TSXAPIFN void tsxMaterialGetTextureProps(
  269.     tsxMATERIAL* pMatrl,
  270.     CtsxTextureProps* pTxtrProps
  271.     );
  272.  
  273.  
  274. // Bump Map ....................................................................
  275.  
  276. // File used as bump map image.
  277. TSXAPIFN void tsxMaterialGetBumpFilename(
  278.     tsxMATERIAL* pMatrl,
  279.     char* szFilename,    // File name copied here, if any
  280.     int iFilenameSize    // size of szFilename buffer
  281.     );
  282.  
  283. // Bump mapping parameters
  284. TSXAPIFN void tsxMaterialGetBumpProps(
  285.     tsxMATERIAL* pMatrl,
  286.     CtsxBumpProps* pBumpProps
  287.     );
  288.  
  289.  
  290. // Environment Map .............................................................
  291.  
  292. // File used as environment map image.
  293. TSXAPIFN void tsxMaterialGetEnvrFilename(
  294.     tsxMATERIAL* pMatrl,
  295.     char* szFilename,    // File name copied here, if any
  296.     int iFilenameSize    // size of szFilename buffer
  297.     );
  298.  
  299.  
  300. // Returns tsxENVR_* (0 on error)
  301. TSXAPIFN int tsxMaterialGetEnvrFlags( tsxMATERIAL* pMatrl );
  302.  
  303.  
  304. //------------------------------------------------------------------------------
  305. //    Attribute Update
  306. //------------------------------------------------------------------------------
  307.  
  308. // Surface attributes ..........................................................
  309.  
  310. // Reflection shading (tsxSHADER_*)
  311. TSXAPIFN void tsxMaterialSetShadingType( tsxMATERIAL* pMatrl, int shading );
  312.  
  313. // Surface faceting (tsxFACET_*)
  314. TSXAPIFN void tsxMaterialSetFacetingType( tsxMATERIAL* pMatrl, int faceting );
  315.  
  316. // The angle in degrees (0 - 120)
  317. TSXAPIFN void tsxMaterialSetAutofacetAngle( tsxMATERIAL* pMatrl,
  318.                         int angleDegrees );
  319.  
  320.  
  321. // Color
  322. TSXAPIFN void tsxMaterialSetColor( tsxMATERIAL* pMatrl, CtsxColor* pColor );
  323.  
  324. // Surface properties
  325. TSXAPIFN void tsxMaterialSetSurfaceProps( tsxMATERIAL* pMatrl,
  326.                       CtsxSurfaceProps* pSprops );
  327.  
  328. // index of refraction (1.0 - 2.0)
  329. TSXAPIFN void tsxMaterialSetIor( tsxMATERIAL* pMatrl, float ior );
  330.  
  331.  
  332. // Texture Map .................................................................
  333.  
  334. // Returns tsxTEXTURE_*
  335. TSXAPIFN void tsxMaterialSetTextureType( tsxMATERIAL* pMatrl, int txtype );
  336.  
  337. // If not procedural texture, pPrTxt->txtrtype = tsxTEXTURE_NONE.
  338. TSXAPIFN void tsxMaterialSetProcTexture( tsxMATERIAL* pMatrl,
  339.                      CtsxProcTexture* pPrTxt );
  340.  
  341. // File used as texture map image.
  342. TSXAPIFN void tsxMaterialSetTextureFilename(
  343.     tsxMATERIAL* pMatrl,
  344.     char* szFilename    // File name ptr (may be NULL)
  345.     );
  346.  
  347. // Texture mapping parameters
  348. TSXAPIFN void tsxMaterialSetTextureProps(
  349.     tsxMATERIAL* pMatrl,
  350.     CtsxTextureProps* pTxtrProps
  351.     );
  352.  
  353.  
  354. // Bump Map ....................................................................
  355.  
  356. // File used as bump map image.
  357. TSXAPIFN void tsxMaterialSetBumpFilename(
  358.     tsxMATERIAL* pMatrl,
  359.     char* szFilename    // File name ptr (may be 0)
  360.     );
  361.  
  362. // Bump mapping parameters
  363. TSXAPIFN void tsxMaterialSetBumpProps(
  364.     tsxMATERIAL* pMatrl,
  365.     CtsxBumpProps* pBumpProps
  366.     );
  367.  
  368.  
  369. // Environment Map .............................................................
  370.  
  371. // File used as environment map image.
  372. TSXAPIFN void tsxMaterialSetEnvrFilename(
  373.     tsxMATERIAL* pMatrl,
  374.     char* szFilename    // File name ptr (may be 0)
  375.     );
  376.  
  377. // Environment flags tsxENVR_*
  378. TSXAPIFN void tsxMaterialSetEnvrFlags( tsxMATERIAL* pMatrl, int flags );
  379.  
  380.  
  381. //******************************************************************************
  382. #endif //TSXMATRL_H
  383.